/*
 * Copyright 2022 The Backstage Authors
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

import {
  GetExploreToolsRequest,
  GetExploreToolsResponse,
} from '@backstage/plugin-explore-common';

/**
 * @public
 */
export interface ExploreToolProvider {
  /**
   * Gets a list of explore tools filtered by the request options.
   *
   * @param request - The request options {@link @backstage/plugin-explore-common#GetExploreToolsRequest}.
   * @returns The response {@link @backstage/plugin-explore-common#GetExploreToolsResponse}.
   */
  getTools(request: GetExploreToolsRequest): Promise<GetExploreToolsResponse>;
}
